/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.jmeter.report.processor;

/**
 * The interface Aggregator represents an aggregator used by graph consumers.
 *
 * @since 3.0
 */
public interface Aggregator {

    /**
     * Gets the number of aggregated values.
     *
     * @return the number of aggregated values
     */
    long getCount();

    /**
     * Gets the result of the aggregation using stored values.
     *
     * @return the result of the aggregation.
     */
    double getResult();

    /**
     * Adds the specified value to the storage of the current aggregator.
     *
     * @param value
     *            the value to aggregate
     */
    void addValue(double value);

    /**
     * Reset the state of the aggregator.
     */
    void reset();
}
